Skip to content

change .readthedocs.yaml to switch publishing docs from rst to markdown#390

Merged
wm-wm-wm merged 15 commits into
developfrom
feature/RTH-switch-to-markdown
Jul 3, 2026
Merged

change .readthedocs.yaml to switch publishing docs from rst to markdown#390
wm-wm-wm merged 15 commits into
developfrom
feature/RTH-switch-to-markdown

Conversation

@wm-wm-wm

Copy link
Copy Markdown
Contributor

Change Summary

Switch documentation publishing from RST to markdown

Related issue number

[DOP-37885]

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

Coverage

Coverage Report •
FileStmtsMissBranchBrPartCoverMissing
syncmaster/server/settings/server
   static_files.py1796647%33–41
TOTAL536864283217488% 

Comment thread .readthedocs.yaml
Comment thread docker-compose.test.yml Outdated
@dolfinus

dolfinus commented Jun 25, 2026

Copy link
Copy Markdown
Member

We should also update:

  • towncrier configs
  • changelog check in CI
  • Makefile jobs for building documentation (sphinx -> mkdocs)
  • CONTRIBUTING.rst (probably should be renamed to .md and used as a snippet)
  • drop docs dependency group from pyproject.toml

See MTSWebServices/onetl@d708d99

@dolfinus dolfinus added the ci:skip-changelog Add this label to skip changelog file check label Jun 29, 2026
@dolfinus

dolfinus commented Jun 29, 2026

Copy link
Copy Markdown
Member

There are 3 .rst files left in the repo:

  • README.rst
  • SECURITY.rst
  • CONTRIBUTING.rst

They should probably be replaced with .md files as well. Also I don't see why we need Security and Contributing sections in mddocs - these files are developer-only, it's enough to store them just in the repo root.

This can be changed in another PR.

@wm-wm-wm wm-wm-wm merged commit b3fea00 into develop Jul 3, 2026
26 checks passed
@wm-wm-wm wm-wm-wm deleted the feature/RTH-switch-to-markdown branch July 3, 2026 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:skip-changelog Add this label to skip changelog file check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants